Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Match unmatched backticks in compiler/ #108685

Merged
merged 3 commits into from
Mar 3, 2023

Conversation

est31
Copy link
Member

@est31 est31 commented Mar 3, 2023

Found with GNU grep:

grep -rEn '^(([^`]*`){2})*[^`]*`[^`]*$' compiler/ | rg -v '\s*[//]?.{1,2}```'

@rustbot
Copy link
Collaborator

rustbot commented Mar 3, 2023

r? @petrochenkov

(rustbot has picked a reviewer for you, use r? to override)

@rustbot rustbot added A-query-system Area: The rustc query system (https://rustc-dev-guide.rust-lang.org/query.html) S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Mar 3, 2023
@rustbot
Copy link
Collaborator

rustbot commented Mar 3, 2023

Some changes occurred to the CTFE / Miri engine

cc @rust-lang/miri

Some changes occurred to MIR optimizations

cc @rust-lang/wg-mir-opt

@est31
Copy link
Member Author

est31 commented Mar 3, 2023

These two I don't know what to put:

/// - S would be `fn(&u32) ->

/// this case as projections as self types add `

@rustbot
Copy link
Collaborator

rustbot commented Mar 3, 2023

Hey! It looks like you've submitted a new PR for the library teams!

If this PR contains changes to any rust-lang/rust public library APIs then please comment with @rustbot label +T-libs-api -T-libs to tag it appropriately. If this PR contains changes to any unstable APIs please edit the PR description to add a link to the relevant API Change Proposal or create one if you haven't already. If you're unsure where your change falls no worries, just leave it as is and the reviewer will take a look and make a decision to forward on if necessary.

Examples of T-libs-api changes:

  • Stabilizing library features
  • Introducing insta-stable changes such as new implementations of existing stable traits on existing stable types
  • Introducing new or changing existing unstable library APIs (excluding permanently unstable features / features without a tracking issue)
  • Changing public documentation in ways that create new stability guarantees
  • Changing observable runtime behavior of library APIs

@saethlin
Copy link
Member

saethlin commented Mar 3, 2023

I think you should split out the library diff into a separate PR, based on this topic: https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Spelling.20is.20style.3F/near/328759605

@est31
Copy link
Member Author

est31 commented Mar 3, 2023

@saethlin I think the concerns were mostly about PRs, many of which very low effort, that were extremely huge and offloaded the reviewing of the tool to the PR reviewer. They had questionable quality, and sometimes it was questionable if they were improvements at all. Here the improvement is tiny, but very clear. It should be easy to review it. I just saw an error message with an unmatched when working on #108682, ` and then wondered about other occurrences of the character in the code.

This PR isn't just changing comments, it's also changing error messages of different kinds (both diagnostics and ICE messages).

@est31 est31 force-pushed the backticks_matchmaking branch 3 times, most recently from dc637b8 to 3d87a83 Compare March 3, 2023 03:27
@est31
Copy link
Member Author

est31 commented Mar 3, 2023

Okay reading through the thread of #58619, changes that only change rustc-internal comments aren't really liked, but if they are small in size, or easy to review they might still be accepted. Changes to public facing features/docs are still definitely wanted, even if cosmetic.

I've split up this PR into multiple commits:

  • "Match end user facing unmatched backticks in compiler/" should be the least controversial. I see ICE messages, diagnostic messages, and lint documentation that gets rendered to the rustc mdbook (from my understanding, correct me if I'm wrong) as end user facing.
  • "Match unmatched backticks in compiler/ that are part of rustdoc" concerns changes to the rustdoc that is rendered to the publicly available rustc-internal rustdoc. Those are rustc developer facing changes.
  • "Match unmatched backticks in comments in compiler/" touches non-rustdoc comments only, that are only read by people who have directly opened the file (instead of browsing the rustdoc). This is probably the most controversial of the bunch.
  • "Rustdoc-ify LiteralKind note" turns a // comment into a rustdoc comment, as well as adjusts an unmatched backtick to use ""s as is done in the surrounding rustdocs. Explicitly wanted.
  • "Don't put integers into backticks during formatting" addresses @saethlin 's comments from above.

The commits have differing levels of controversialness. Please tell me which ones are not wanted and I should remove, and which ones I should put into different PRs. Thanks!

@est31 est31 changed the title Match unmatched backticks Match unmatched backticks in compiler/ Mar 3, 2023
@est31
Copy link
Member Author

est31 commented Mar 3, 2023

Alright I have removed the commit that only changed the comments. I don't agree with the policy, and it might not actually be unwanted by that policy, but ultimately it's a choice I have to respect. Now all the changes should be non-controversial ones, I hope.

@Noratrieb
Copy link
Member

You can make a separate PR with the compiler comments and add me or @WaffleLapkin as the reviewer, we're fine with reviewing it.

@est31
Copy link
Member Author

est31 commented Mar 3, 2023

Alright, I have removed even the rustdoc changes from this PR (outside of the one commit about LiteralKind) and moved the two into #108694. Sorry for all the noise, I hope now it should be easy enough to review the patches.

@petrochenkov
Copy link
Contributor

petrochenkov commented Mar 3, 2023

Changes in this PR are certainly not in the same category (and amount) as in PRs that motivated #58619.
Missing left or right quotes a obviously typos/mistakes.
@bors r+

@bors
Copy link
Contributor

bors commented Mar 3, 2023

📌 Commit c54f061 has been approved by petrochenkov

It is now in the queue for this repository.

@bors
Copy link
Contributor

bors commented Mar 3, 2023

🌲 The tree is currently closed for pull requests below priority 100. This pull request will be tested once the tree is reopened.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 3, 2023
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 3, 2023
…rochenkov

Match unmatched backticks in compiler/

Found with GNU grep:
```
grep -rEn '^(([^`]*`){2})*[^`]*`[^`]*$' compiler/ | rg -v '\s*[//]?.{1,2}```'
```
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 3, 2023
…ts, r=Nilstrieb

Match unmatched backticks in compiler/ comments

r? `@Nilstrieb` as per [advice](rust-lang#108685 (comment))
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 3, 2023
…y, r=jyn514

Match unmatched backticks in library/

Found with GNU grep:

```
grep -rEn '^(([^`]*`){2})*[^`]*`[^`]*$' library/ | rg -v '\s*[//]?.{1,2}```'
```

split out from rust-lang#108685 as per advice.
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 3, 2023
…ts, r=Nilstrieb

Match unmatched backticks in compiler/ comments

r? ``@Nilstrieb`` as per [advice](rust-lang#108685 (comment))
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 3, 2023
…y, r=jyn514

Match unmatched backticks in library/

Found with GNU grep:

```
grep -rEn '^(([^`]*`){2})*[^`]*`[^`]*$' library/ | rg -v '\s*[//]?.{1,2}```'
```

split out from rust-lang#108685 as per advice.
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 3, 2023
…iaskrgr

Rollup of 7 pull requests

Successful merges:

 - rust-lang#107981 (new solver: implement canonicalization and region constraints)
 - rust-lang#108553 (Deny capturing late-bound non-lifetime param in anon const)
 - rust-lang#108599 (Remove legacy PM leftovers)
 - rust-lang#108667 (Fix another ICE in `point_at_expr_source_of_inferred_type`)
 - rust-lang#108674 (Clippy Fix array-size-threshold config deserialization error)
 - rust-lang#108685 (Match unmatched backticks in compiler/)
 - rust-lang#108694 (Match unmatched backticks in compiler/ comments)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 846424d into rust-lang:master Mar 3, 2023
@rustbot rustbot added this to the 1.69.0 milestone Mar 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-query-system Area: The rustc query system (https://rustc-dev-guide.rust-lang.org/query.html) S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants